IAMEdmUICache interface

This interface implements functionality required to access the content of a document stored in the vault.

Remarks

When AMFS is used to access documents in the vault, then the Location property returns the path to the document on the AMFS share. This path can be used to read/write the document or open it in an application.

When Local Workspace is used, the same Location property will return the path of the document in the Local Workspace folder. It will automatically ensure the correct revision of the document is available.

The Status property will return an AMUICACHESYNCTYPES constants value that describes the state of the document in the Local Workspace. For AMFS this value is always AMUICACHE_DONOTHING.

Following is a table of the possible lock types:

The sample code below demonstrates how to access documents from code. The GetDocumentPath method returns the path where the document can be found. This will work for both AMFS and Local Workspace.

The SetDocumentLock(doc, True)method will make the document writable (assuming it is a working copy or Under Change).

Related information

AMDocumentUI object

IAMEdmItemsUIPersist interface

Example

Public Function GetDocumentPath(doc As AMDocument) As String
    GetDocumentPath = ""
    
    If Not doc Is Nothing Then
        'Create AMDocumentUI and take IAMEdmUICache interface
        Dim DocLocation As IAMEdmUICache
        Set DocLocation = New AMDocumentUI
    
        'Take IAMEdmUIPersist interface from AMDocumentUI
        Dim Persist As IAMEdmUIPersist
        Set Persist = DocLocation
    
        'Initialize AMDocumentUI object with AMDocument
        Persist.Init doc
    
        'Take IAMEdmUICache interface from AMDocumentUI object
        GetDocumentPath = DocLocation.Location(AMUICACHE_DEFAULT)
      
        Set DocLocation = Nothing
        Set Persist = Nothing
    End If
    
End Function
  
Public Sub SetDocumentLock(doc As AMDocument, bLock As Boolean)
    
    If Not doc Is Nothing Then
        'Create AMDocumentUI and take IAMEdmUICache interface
        Dim DocLocation As IAMEdmUICache2
        Set DocLocation = New AMDocumentUI
        
        'Take IAMEdmUIPersist interface from AMDocumentUI object
        Dim Persist As IAMEdmUIPersist
        Set Persist = DocLocation
    
        'Initialize AMDocumentUI object with AMDocument
        Persist.Init doc
    
        If bLock Then
            ' No locking required for AMFS
            If Not DocLocation.IsAmfs Then
                ' Lock the document.
                ' The document in the Local Workspace will be updated and made  writable
                DocLocation.SetLock AMLT_THIS
            End If
        Else
            ' Unlock the document. 
            DocLocation.SetLock AMLT_NOLOCK
        End If
      
        Set DocLocation = Nothing
        Set Persist = Nothing
    End If
    
End Sub